home *** CD-ROM | disk | FTP | other *** search
/ Utilities Professional 1-1500 / Utilities Professional 1-1500 (1994)(WPD)[!].iso / 10011250 / var1118.dms / var1118.adf / s l docs < prev    next >
Text File  |  1993-01-05  |  16KB  |  534 lines

  1.  
  2.  
  3.  
  4.              My address is:
  5.                                  Mark M Forrester,
  6.                                  9 Tayview Road,
  7.                                  Liff,
  8.                                  By Dundee,
  9.                                  Scotland,
  10.                                  DD2 5PE
  11.  
  12.  
  13.  
  14.                                Software Lister v2.0
  15.  
  16.  
  17.                             (c) 1993 Mark M Forrester.
  18.  
  19.  
  20.                                     User Guide.
  21.  
  22.  
  23.  
  24.  
  25.         Contents.
  26.  
  27.  
  28.                 Item.
  29.  
  30.                 1. Shareware Notice.
  31.                 2. Introduction.
  32.                 3. Using The Gadgets.
  33.                 4. Menu Items.
  34.                 5. Conclusion.
  35.                 6. Appendix A - Using The Convert Program.
  36.                 7. Appendix B - Improvements Made.
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.         1. Shareware Notice.
  44.  
  45.         This program is a SHAREWARE product.
  46.  
  47.         If you like and use  the  program  please  send £5 to the
  48.         address found in this file.
  49.  
  50.         If this is done you will be added to my registration list
  51.         regarding future versions or projects.
  52.  
  53.         Please send  critical  evaluations,   bugs,  improvements
  54.         e.t.c. to the same address.  All mail will be answered.
  55.  
  56.         Thank you very much.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.         2. Introduction.
  64.  
  65.         The purpose  of  this  program  is  not  to  be  the best
  66.         database program in the  world  but  to  be  a ready made
  67.         database for a specific purpose.  Since everyone who will
  68.         use  this  program  will  have   some  kind  of  software
  69.         collection it should be of use.
  70.  
  71.         As the program is a purpose built database it is ready to
  72.         use for the intended   purpose   immediately.  No setting
  73.         up is needed.  Simply load and use the program.
  74.  
  75.         Thank you.
  76.  
  77.  
  78.  
  79.  
  80.  
  81.  
  82.         3. Using The Gadgets.
  83.  
  84.         There are two types of  gadgets  used within the program.
  85.         These are:
  86.  
  87.                 - Boolean Gadgets
  88.  
  89.                 - String Gadgets
  90.  
  91.         A boolean gadget is simply one which is either off or on.
  92.         These are used simply by clicking inside the box in which
  93.         they sit.  Examples of boolean gadgets within the program
  94.         are:
  95.  
  96.                 - The 'Done' gadget in the amend section.
  97.  
  98.                 - The 'Ok' gadget in the requesters.
  99.  
  100.         The string gadgets are  a  little more complex,  although
  101.         still very easy to use.  These  are empty boxes with some
  102.         text on the left hand side  of them.  This text describes
  103.         what is required in them.  To enter a string simply click
  104.         inside the box of the gadget and a cursor will appear
  105.  
  106.         Now you  may  type  in  what  you  like.   The  amount of
  107.         characters you are allowed  depends  on  the  size of the
  108.         gadget.  The name field  is  quite  large while the disks
  109.         field is very small.
  110.  
  111.         Other facilities  are  available  when  in  control  of a
  112.         string gadget.  These are listed below:
  113.  
  114.                 - Left and  right  cursor  keys  move  the cursor
  115.                   within the gadget.
  116.  
  117.                 - Shift with either of the  cursor keys moves the
  118.                   cursor to the far right or left depending which
  119.                   one was chosen
  120.  
  121.                 - Backspace deletes a  character  to  the left of
  122.                   the cursor.
  123.  
  124.                 - Del deletes the character under the cursor.
  125.  
  126.                 - CTRL X clears the gadget.
  127.  
  128.                 - RETURN exits from the gadget.
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.         4. Menu Items.
  136.  
  137.         Next follows a descriptions of  all the options available
  138.         through the menu bar.   Each  item  will  be described in
  139.         detail showing what it does and how to to it.
  140.  
  141.         First of all a brief  summary  of  how  to use the menus.
  142.  
  143.         Once the  program  has  loaded  and  run  the  four menus
  144.         may  be   highlighted   by   pressing   and  holding  the
  145.         RIGHT mouse button.
  146.  
  147.         Now,  when you place the cursor over the name of the menu
  148.         all  the  options   available    from    that  menu  will
  149.         be displayed.
  150.  
  151.         To select one of the options  simply move the cursor down
  152.         the menu until the desired  function is highlighted.  The
  153.         option will be selected when  you release the right mouse
  154.         button.
  155.  
  156.  
  157.         4.1 Project Menu.
  158.  
  159.         All the following items are in the project section of the
  160.         menus.
  161.  
  162.  
  163.         4.1.1 New.
  164.  
  165.         This command is used to clear the computers memory of any
  166.         lists which exist.
  167.  
  168.         Beware,   any  existing data entered  into memory will be
  169.         erased when using this option.   However a requester will
  170.         be displayed if the current data has not been saved.
  171.  
  172.  
  173.         4.1.2 File.
  174.  
  175.         This option  is  used  to  perform  all  the  disk  based
  176.         operations of the software.
  177.  
  178.         When the requester appears  it  will  display the current
  179.         directory.  This can be changed by either clicking on one
  180.         of the disk gadgets (df0:,  df1:  or dh0:) or by entering
  181.         text into the DRAWER gadget.
  182.  
  183.         Once the  directory  is  displayed  then  you  may browse
  184.         though the files with the bar on the right.
  185.  
  186.         You may change directory by  simply clicking on it within
  187.         the directory list or by  using  the  small '<' symbol to
  188.         move to the parent of the current directory.
  189.  
  190.         A file may be selected  by  clicking  on it's name in the
  191.         directory list or by typing  it's  name directly into the
  192.         FILE gadget.
  193.  
  194.         Once the file has been selected then the operation may be
  195.         selected.  Four operations are valid.
  196.  
  197.                 - LOAD
  198.  
  199.                 - SAVE
  200.  
  201.                 - DELETE
  202.  
  203.                 - CANCEL
  204.  
  205.         LOAD simply attempts to load  the requested file in (this
  206.         file must have  been  previously  created  with 'Software
  207.         Lister v2.0' / adapted with  the  'Convert' program or it
  208.         will not load).
  209.  
  210.         SAVE saves  the  current  list  to  the  file  which  was
  211.         selected.
  212.  
  213.         DELETE removes the selected file  from the disk.  If this
  214.         is selected then a requester  will  ask  to make sure you
  215.         meant what you have just done.  If you choose Ok then the
  216.         file will be deleted.
  217.  
  218.         CANCEL leaves  the  file  requester  with  no  operations
  219.         performed  (this  may  also   be   done  by  closing  the
  220.         requester's window).
  221.  
  222.  
  223.  
  224.  
  225.         4.1.3 About.
  226.  
  227.         Displays the name and version of the program and also the
  228.         name of the programmer and any contributors.
  229.  
  230.  
  231.         4.1.4 Quit.
  232.  
  233.         Used to exit from the program.
  234.  
  235.         If the  user  has  not  saved  the  current  list  then a
  236.         requester will be displayed asking  if it should be done.
  237.         If 'Ok' then the list will  be saved as the last filename
  238.         used or if none  has  been  used  then  it will be called
  239.         'default.dat'.
  240.  
  241.         If 'No'  is  selected  any  unsaved   file   currently in
  242.         memory will be lost and the  user will be returned to the
  243.         workbench.
  244.  
  245.  
  246.  
  247.         4.2 Data.
  248.  
  249.         All the options in  this  menu  concern changing the data
  250.         currently held in memory.  Data may be added,  deleted or
  251.         amended.
  252.  
  253.  
  254.         4.2.1 Add A Record.
  255.  
  256.         Allows the user to  add  a  single  record to the current
  257.         memory contents.
  258.  
  259.         When selected the  user  will  be  prompted  for  all the
  260.         details about the piece of software.
  261.  
  262.         After the name is typed  in,   the  program checks to see
  263.         if the record  already   exists.    If  not  the  program
  264.         will continue otherwise an error will occur.
  265.  
  266.         Once all the data  has  been  entered  the record will be
  267.         inserted into it's  correct  position  in  the list.  The
  268.         list is alphabetically sorted on the NAME field.
  269.  
  270.  
  271.         4.2.2 Add Number Of Records.
  272.  
  273.         Similar to the add a  record  option except it allows the
  274.         user to specify how many records will be added at once.
  275.  
  276.         Before any data about  the  software  is entered the user
  277.         will be prompted for the  number  of records they wish to
  278.         add.   Once  this  is  entered  the  user  will  then  be
  279.         requested for the data about each software item until the
  280.         specified number of records are added.
  281.  
  282.         As before,   after  each  record  is  added  it  will  be
  283.         inserted into the correct position in the list.
  284.  
  285.  
  286.         4.2.3 Delete A Record.
  287.  
  288.         This option allows you delete a record from the list.
  289.  
  290.         When selected you will  be  prompted  for the name of the
  291.         software item to remove  from the list.  Once entered the
  292.         record will be deleted from the list.
  293.  
  294.  
  295.         4.2.4 Amend A Record.
  296.  
  297.         Allows you to  change  data  in   a  record which already
  298.         exists.
  299.  
  300.         The user will be prompted  for  the  name of the software
  301.         item which needs amended.  Once the name has been entered
  302.         the record will be displayed  on  the  screen.
  303.  
  304.         Now you simply need to click  inside the field box of the
  305.         item you wish to amend  and  then make any changes.  Then
  306.         press return when finished.   This  may  be  done as many
  307.         times as you like on any of the fields.
  308.  
  309.         To exit from this simply  click  on  the 'Done' gadget in
  310.         the bottom right hand corner of the window.
  311.  
  312.         If   the   name   field    is    changed   it   will   be
  313.         correctly repositioned in the list.
  314.  
  315.  
  316.         4.3 Display.
  317.  
  318.         All commands in this section are used to display the data
  319.         in the memory in different ways.
  320.  
  321.  
  322.         4.3.1 Display A Record.
  323.  
  324.         Allows the user to display a record on the screen.
  325.  
  326.         Simply type the name  of  the  item  to be displayed when
  327.         prompted.  The  record  will  then  be  displayed  on the
  328.         screen.
  329.  
  330.  
  331.         4.3.2 Display All Records.
  332.  
  333.         Lets you display all the records currently in memory onto
  334.         the screen.
  335.  
  336.         When selected the first   record   will be displayed.  If
  337.         you wish to continue  click  on  the 'Cont' gadget.  This
  338.         will display the next record.
  339.  
  340.         However if you wish  to  exit  at  any  point then simply
  341.         click on the 'Quit' gadget.
  342.  
  343.  
  344.         4.3.4 Display On Producer.
  345.  
  346.         Allows the user to  display  all  the  items  in the list
  347.         which were made by a specified producer.
  348.  
  349.         Select  the  option  and  you  will  be  prompted  for  a
  350.         producer.  Provided there  are  records  which  have this
  351.         producer  then  a  list    of   all  the  software  items
  352.         made by that producer will be displayed onto the screen.
  353.  
  354.         NOTE:   Since not  all  the  data  will  be  able  to  be
  355.                 displayed on the screen at once the list is split
  356.                 and a number of records  will be displayed on one
  357.                 screen.
  358.  
  359.                 Therefore when one section  is displayed you have
  360.                 the option of  either  continuing  with  the list
  361.                 (select the 'Cont' gadget) or exiting back to the
  362.                 menu (the 'Quit' gadget).
  363.  
  364.  
  365.         4.3.5 Display On Type.
  366.  
  367.         Displays a list of  a  specified  software  type onto the
  368.         screen.
  369.  
  370.         A type is prompted for  and  once  entered  a list of all
  371.         software of that type is listed.
  372.  
  373.         For example,  a list of games:
  374.  
  375.                 Shoot Em Up,
  376.                 Platform,
  377.                 e.t.c.
  378.  
  379.         Utilities:
  380.  
  381.                 Text Editor,
  382.                 Copier,
  383.                 e.t.c.
  384.  
  385.         The same quit and continue options exist for this as with
  386.         the 'display on producer' function.
  387.  
  388.  
  389.         4.3.6 Display List.
  390.  
  391.         Displays a complete  list  of  all  software currently in
  392.         memory onto the screen.
  393.  
  394.         By selecting the option  from  the  menu  a  list will be
  395.         automatically displayed.
  396.  
  397.         The same quit and continue options exist for this as with
  398.         the 'display on producer' function.
  399.  
  400.  
  401.  
  402.         4.4 Print.
  403.  
  404.         All items in this  menu  are  exactly  the  same as their
  405.         'display' counterparts except that the output is directed
  406.         to the printer as opposed to the screen.
  407.  
  408.         All output  will  be  paginated  according  to  normal A4
  409.         paper.
  410.  
  411.         If the printer is not  ready  when any of these functions
  412.         are called then a delay is  given (to correct the error).
  413.         After the delay  a  requester  will  appear  allowing the
  414.         print job to be cancelled.
  415.  
  416.  
  417.         NOTE:   Should you require  to  use  a  different printer
  418.                 driver than the one  on  this disk simply copy it
  419.                 into 'devs/printers' directory  of  this disk and
  420.                 set  the  printer  using   the  preferences  tool
  421.                 (details  of  how   to   do   this   are  in  the
  422.                 introduction manual supplied with the Amiga).
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.         5. Conclusion.
  430.  
  431.         Thanks for spending the time to read the instructions.
  432.  
  433.         However,  the best  instruction  is  to  actually use the
  434.         software.  The user interface  is  quite  friendly so you
  435.         shouldn't have too many problems.
  436.  
  437.         As I have said  before,    if   you  do have any problems
  438.         don't hesitate to contact me  at  the  address I am about
  439.         to give as all mail will be answered.
  440.  
  441.         If you copy this program  onto another disk please ensure
  442.         that this document file is copied along with it.
  443.  
  444.         Thanks again for taking the time to read this file.
  445.  
  446.  
  447.         My address is:
  448.  
  449.                 Mark M Forrester,
  450.                 9 Tayview Road,
  451.                 Liff,
  452.                 By Dundee,
  453.                 Scotland,
  454.                 DD2 5PE
  455.  
  456.         Please support shareware programmers!
  457.  
  458.         Thanks again,  I look forward to hearing from you.
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.         6. Appendix A - Using The Convert Program.
  466.  
  467.         Since version 2 of the program  now uses a different file
  468.         format from that of the  previous  versions they will not
  469.         now be compatible with the new program.
  470.  
  471.         The Convert program (as the name suggests) rectifies this
  472.         by changing the  original  software  lister  files to the
  473.         correct format for version 2.
  474.  
  475.         This is very simply  done.   Once  the program has loaded
  476.         two string gadgets exist.   One  for  the input file (the
  477.         old file) and one for the file which is to be created.
  478.  
  479.         Simply enter the full path name  of the two files (unless
  480.         they are in the current directory) into the gadgets.
  481.  
  482.         e.g.
  483.  
  484.                 INPUT:  df0:files/games.dat
  485.  
  486.                 OUTPUT: amiga-games.dat
  487.  
  488.         Now click on 'Ok' and the  program will convert the file.
  489.         If any problems occur a  requester will be displayed with
  490.         information on the problem.
  491.  
  492.         Note that the file names  MUST  be different.  You cannot
  493.         for example have:
  494.  
  495.                 INPUT:  games.dat
  496.  
  497.                 OUTPUT: games.dat
  498.  
  499.         But you may have:
  500.  
  501.                 INPUT:  df0:files/games.dat
  502.  
  503.                 OUTPUT: games.dat
  504.  
  505.         Provided the current  directory  is  not  'df0:files/' as
  506.         AmigaDos takes these as two different file names.
  507.  
  508.         When finished just click on the 'Done' gadget.
  509.  
  510.  
  511.  
  512.  
  513.  
  514.  
  515.         7. Appendix B - Improvements Made.
  516.  
  517.         There follows a list  of  improvements  made over version
  518.         1.6 of the program:
  519.  
  520.                 - File  requester  now   used   for  easier  file
  521.                   handling.
  522.  
  523.                 - Dynamic memory allocation now used so amount of
  524.                   records storable only limited by memory size.
  525.  
  526.                 - Much faster operation of the program.
  527.  
  528.                 - Better look  and  feel  to  the  program  (more
  529.                   standard to the amiga).
  530.  
  531.                 - Easier to transport to  another  disk as it has
  532.                   no support files which must  be copied with it.
  533.                   Just move the icon to the desired location.
  534.